<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>PowerVR SDK</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<table width="100%">
  <tr>
    <td width="33%">
      <p align="left">&nbsp;<a href="http://www.imgtec.com"><img border="0" src="IMGLogo.jpg" width="200" height="30"></a></p>
    </td>
    <td width="33%">
      <p align="center"><font color="#808080" face="Arial" size="2">PowerVR Software Development Kit</a></font></p>
    </td>
    <td width="34%">
      <p align="right"><a href="http://www.powervr.com"><img border="0" src="PVRlogo.jpg" width="200" height="27"></a></p>
    </td>
  </tr>
</table>
<hr>
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>pvrengine::Light Class Reference</h1>Class to hold a <a class="el" href="classpvrengine_1_1Light.html">Light</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Light_8h-source.html">Light.h</a>&gt;</code>
<p>
Inheritance diagram for pvrengine::Light:<p><center><img src="classpvrengine_1_1Light__inherit__graph.png" border="0" usemap="#pvrengine_1_1Light__inherit__map" alt="Inheritance graph"></center>
<map name="pvrengine_1_1Light__inherit__map">
<area href="classpvrengine_1_1LightDirectional.html" shape="rect" coords="7,82,188,108" alt="">
<area href="classpvrengine_1_1LightPODDirectional.html" shape="rect" coords="212,82,423,108" alt="">
<area href="classpvrengine_1_1LightPODPoint.html" shape="rect" coords="447,82,625,108" alt="">
<area href="classpvrengine_1_1LightPoint.html" shape="rect" coords="649,82,799,108" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classpvrengine_1_1Light-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#a0">Light</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#a1">Light</a> (const PVRTVec3 &amp;v3Colour, const <a class="el" href="namespacepvrengine.html#a95">ELightType</a> eLightType)</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#a2">~Light</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#a3">shineLight</a> (unsigned int i32Index)=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>PVRTVec3&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#a4">getColour</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespacepvrengine.html#a95">ELightType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#a5">getType</a> ()</td></tr>

<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>PVRTVec3&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#p0">m_v3Colour</a></td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespacepvrengine.html#a95">ELightType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classpvrengine_1_1Light.html#p1">m_eLightType</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to hold a <a class="el" href="classpvrengine_1_1Light.html">Light</a>. 
<p>
<dl compact><dt><b>Description:</b></dt><dd>Class to hold a <a class="el" href="classpvrengine_1_1Light.html">Light</a> </dd></dl>

<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="pvrengine::Light::Light" ></a><p>
<br><br><h3>Light</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> pvrengine::Light::Light </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>blank constructor. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="pvrengine::Light::Light" ></a><p>
<br><br><h3>Light</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> pvrengine::Light::Light </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const PVRTVec3 &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>v3Colour</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="namespacepvrengine.html#a95">ELightType</a>&nbsp;</td>
          <td class="mdname" nowrap> <em>eLightType</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Inputs:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>v3Colour</em>&nbsp;</td><td>- colour of light </td></tr>
    <tr><td valign=top><em>eLightType</em>&nbsp;</td><td>- type of light </td></tr>
  </table>
</dl>
<dl compact><dt><b>Description:</b></dt><dd>blank constructor. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="pvrengine::Light::~Light" ></a><p>
<br><br><h3>~Light</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual pvrengine::Light::~<a class="el" href="classpvrengine_1_1Light.html">Light</a> </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Description:</b></dt><dd>deconstructor. </dd></dl>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4" doxytag="pvrengine::Light::getColour" ></a><p>
<br><br><h3>getColour</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> PVRTVec3 pvrengine::Light::getColour </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Returns:</b></dt><dd>the colour of the light </dd></dl>
<dl compact><dt><b>Description:</b></dt><dd>retrieves the colour of this light </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a5" doxytag="pvrengine::Light::getType" ></a><p>
<br><br><h3>getType</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespacepvrengine.html#a95">ELightType</a> pvrengine::Light::getType </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [inline]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Returns:</b></dt><dd>type of the light </dd></dl>
<dl compact><dt><b>Description:</b></dt><dd>gets the type of this light. </dd></dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="pvrengine::Light::shineLight" ></a><p>
<br><br><h3>shineLight</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void pvrengine::Light::shineLight </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned int&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>i32Index</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<dl compact><dt><b>Inputs:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>i32Index</em>&nbsp;</td><td>- index of the light to shine </td></tr>
  </table>
</dl>
<dl compact><dt><b>Description:</b></dt><dd>sets up a hardware light (not functional in OpenGL) </dd></dl>

<p>
Implemented in <a class="el" href="classpvrengine_1_1LightPoint.html#a6">pvrengine::LightPoint</a>, <a class="el" href="classpvrengine_1_1LightDirectional.html#a6">pvrengine::LightDirectional</a>, <a class="el" href="classpvrengine_1_1LightPODDirectional.html#a3">pvrengine::LightPODDirectional</a>, and <a class="el" href="classpvrengine_1_1LightPODPoint.html#a3">pvrengine::LightPODPoint</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p1" doxytag="pvrengine::Light::m_eLightType" ></a><p>
<br><br><h3>m_eLightType</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="namespacepvrengine.html#a95">ELightType</a> <a class="el" href="classpvrengine_1_1Light.html#p1">pvrengine::Light::m_eLightType</a><code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
colour of this light     </td>
  </tr>
</table>
<a class="anchor" name="p0" doxytag="pvrengine::Light::m_v3Colour" ></a><p>
<br><br><h3>m_v3Colour</h3><br><div>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> PVRTVec3 <a class="el" href="classpvrengine_1_1Light.html#p0">pvrengine::Light::m_v3Colour</a><code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Light_8h-source.html">Light.h</a></ul>
<br>
<br>
<P align=left><FONT size=2><STRONG><A 
   href="http://www.imgtec.com/powervr/insider/legal/index.asp">Copyright</A> � 
   1999-2008, Imagination Technologies Ltd.</STRONG></FONT></P>
<hr>
<address style="align: left;"><small><FONT color=f0f>
Generated by <a href="http://www.doxygen.org/index.html">DOXYGEN</a> 1.3.6</small></address>
</body>
</html>
